Skip to content

feat(ErrorLogger): do not show the exception info on DEBUG mode #6075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
May 21, 2025
Merged

feat(ErrorLogger): do not show the exception info on DEBUG mode #6075

merged 3 commits into from
May 21, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 21, 2025 •
edited by sourcery-ai bot
Loading

Link issues

fixes #6074

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Bug Fixes:

  • Show exception stack traces only in DEBUG mode to avoid exposing details in production.

@bb-auto bb-auto bot added the enhancement New feature or request label May 21, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 21, 2025 •
edited
Loading

Reviewer's Guide

Wrap exception details rendering in DEBUG builds so that exception stack information is only displayed during development and hidden in production.

File-Level Changes

Change Details Files
Limit exception details display to debug builds via conditional compilation
  • Added #if DEBUG directive before exception rendering logic
  • Inserted comment explaining debug-mode behavior
  • Added matching #endif after exception rendering
 src/BootstrapBlazor/Components/ErrorLogger/BootstrapBlazorErrorBoundary.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6074 Do not show exception information in DEBUG mode. ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the v9.6.0 milestone May 21, 2025
@ArgoZhang ArgoZhang requested a review from Copilot May 21, 2025 11:33
Copilot AI reviewed May 21, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR restricts the display of exception details to debug builds only, ensuring that sensitive exception information is not shown in release mode. Key changes include wrapping the UI exception rendering logic within a "#if DEBUG" block and updating inline comments accordingly.

  • Wrap exception rendering logic in a conditional compilation block (#if DEBUG).
  • Add inline comments to clarify debug-only behavior.

@codecov
Copy link

codecov bot commented May 21, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (04bb996) to head (a866f58).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #6075   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          701       701           
  Lines        30944     30944           
  Branches      4376      4376           
=========================================
  Hits         30944     30944

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 10a6739 into main May 21, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-errorlogger branch May 21, 2025 11:40
@ArgoZhang ArgoZhang restored the feat-errorlogger branch May 22, 2025 03:26
@ArgoZhang ArgoZhang deleted the feat-errorlogger branch May 22, 2025 03:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.6.0

Development

Successfully merging this pull request may close these issues.

feat(ErrorLogger): do not show the exception info on DEBUG mode

2 participants

@ArgoZhang